CIMPLICITY REST API Web Service
CIMPLICITY REST API Web Service / All Operations Resource Group / /projects/{projectId}/historianConnections:read (Post)
In This Topic
    Post/projects/{projectId}/historianConnections:read
    In This Topic
    Description
    Gets an array of historian connection objects that satisfy the filter criteria specified in the request body.
    Parameters
    NameDescriptionData Type
    the id of the projectstring
    Request (application/json)

    The request body is of type object.

    Overview

    connectionID : string
    provides a wild card string to filter historian connections by their ConnectionID.
    serverName : string
    provides a wild card string to filter historian connections by their Server name.
    description : string
    provides a wild card string to filter historian connections by their Description.
    limit : integer
    skip : integer
    200 Response

    The response body is of type HistorianConnectionsGetResponse.

    The collection of historian connections that satify the query.

    Overview

    HistorianConnectionsGetResponse
    The results of the historian connections get query.
    HistorianConnections : Array[CimHistorianConnection]
    An array of the historian connections that satify the query criteria.
    ConnectonID : string
    The Id of historian connection.
    ServerName : string
    The server that the connection will connect to.
    Description : string
    The desciption of the connection.
    UserID : string
    The user ID the connection is made with.
    Passsword : string
    The password the connection is made with. This password will not be in get responses. It may be in create/update requests.
    UsesIdentity : boolean
    set it to true to specify user name and password.
    Fault Responses
    FaultDescription
    This fault returns a response body of type ProblemDetails.
    project with the given id is not registered on the system
    Remarks
    Returns JSON containing an array of historian connection objects
    See Also